Skip to main content
Feedback

Applications

The Configure APIs and Applications > Applications link in the API Management menu opens the Applications page, which you use to view and manage your Applications that allow entities to access an API.

Users create Applications, which allow another entity, such as a business unit or third-party application, to access the API. The system generates an API Key for each subscription of the Application so that it can authorize users for specific API access with a specific Plan.

The API Gateway groups Applications on the Applications page.

Name
Description

Search box
Use this to search for applications by application name or owner name. Search results respect the selected filter. For example, if in the Enabled view you search for an application named MyApp, the page lists only applications containing MyApp in their name with status Enabled.

Application Name
The name of the registered application.

Owner Name
The name of the application owner.

Subscriptions
Indicates the number of total subscriptions for the Application, even if you disabled the subscriptions or they expired. Click the text in this field to add or modify a subscription.

Either you as the API publisher or the Developer Portal user as the API consumer can disable a specific subscription to an application. If you want to disable the subscription, click Disabled by Publisher. If you disable the subscription status, the Developer Portal user cannot enable it. However, if a Developer Portal user disables the subscription, you are able to enable it.

If the application status is disabled, you are unable to modify the individual subscription status.

Date Created
The date that the application was created.

Last Used
Shows the last time this application called an API on an runtime.

Status
Indicates whether the application is enabled or disabled. Click Enabled or Disabled to change the status.

Either you as the API publisher or the Developer Portal user as the API consumer can disable the application. If you want to disable the application, click Disabled by Publisher in the Application Status window. If you disable the application status, the Developer Portal user cannot enable it. However, if a Developer Portal user disables the application, which shows as Disabled by Consumer, you are able to enable it. As the API publisher, you cannot select Disabled by Consumer in the Application Status window.

When disabling the application status, the associated API Keys are disabled, but the subscription statuses are not modified. However, if the application status is disabled, you are unable to modify the subscription status.

Remove
Click Delete icon to delete the application.

Clicking on the name of an Application opens the Application page that allows you to edit the Application.